Skip to content

API keys, local PR edition #1115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 260 commits into from
May 24, 2023
Merged

API keys, local PR edition #1115

merged 260 commits into from
May 24, 2023

Conversation

krivard
Copy link
Contributor

@krivard krivard commented Mar 29, 2023

Activates support for API keys in the Epidata API server.

Prerequisites:

  • Unless it is a documentation hotfix it should be merged against the dev branch
  • Branch is up-to-date with the branch to be merged with, i.e. dev
  • Build is successful
  • Code is cleaned up and formatted

Summary

Copied remaining TODOs from #1061 but they may not be accurate:

  • fix logging (for now we are logging user requests with api_key even without asking user wether he wants to be logged)
  • update documentation ???
  • add tests for admin endpoint
  • define a good default rate limit
  • consider using Redis DB also for account management instead of SQL server

@dmytrotsko
very basic admin interface
c7ca927
@dmytrotsko
list all known roles
d066a90
@dmytrotsko
remove log statement
8b09387
@dmytrotsko
fixup tests
e940f8b
@dmytrotsko
add record flag to user
8bb2789
@dmytrotsko
basic record based on flag logging
3161d2e
@dmytrotsko
rename column to tracking
9ab8978
@dmytrotsko
add webhook endpoint for google forms and simplify table
54dc83c
@dmytrotsko
tests for simplified api_user
62122cf
@dmytrotsko
prepare for sending mails with mailgun
32096ac
@dmytrotsko
disable security check for test setup
45414bc
@dmytrotsko
fix tests
60f7cd6
@dmytrotsko
add registered flag
dac3fcb
@dmytrotsko
request a simple api key form with recaptcha check
d880795
@dmytrotsko
implement rate limiting
e76cde4
@dmytrotsko
registered flag not saved
f1f008e
@dmytrotsko
mark all tests no rate limit
98315c6
@dmytrotsko
add link to registration form within api key form
f897e28
@dmytrotsko
elevate sqlalchemy log level to ERROR for test purpose
b345f76
@dmytrotsko
add structlog to requirements
5ce96bd
@dmytrotsko
add structured logging module
f851d5b
@dmytrotsko
implement api key scrubbing logs and getter functions for User class
38abd83
@dmytrotsko
minor commenting change
d65acb8
@dmytrotsko
change logging to kward format and add a get function for API key
5aee08f
@dmytrotsko
move mask_apikey function out of User class
7378e8d
@dmytrotsko
minor change in variable name
02a535b
@dmytrotsko
Fixed test
c18a122
@dmytrotsko
added missing import
da947fd
@dmytrotsko
Fixed _is_public_route method. Added URL_PREFIX to list of routes
4732467
@dmytrotsko
Merge pull request #2 from dmytrotsko/fix_admin_endpoint_access
ae1e6a1 
Fixed _is_public_route method. Added URL_PREFIX to list of routes
melange396 and others added 5 commits May 22, 2023 15:44
@melange396
fix 'multiples' detection so it recognizes date ranges as well
0bda3a8
@melange396
fix 'multiples' detection, cant do instance checks w/ subscripted gen…
a01d894 
…erics (as is )
@melange396
fix 'multiples' detection, check for list instead of Sequence)
806b6b2
@krivard @melange396
Text check for rollout (#1171)
51b0ac4 
* Fix temporary key and contact point msgs
* Removed exceptions no longer in use
  * UnAuthenticatedException
  * MissingAPIKeyException
* Synced rollout warnings to approved comms
* Fixed per minute -> per hour, and added "free" where it was supposed to be
* Increase longevity of rate limit warning

Co-authored-by: melange396 <[email protected]>
@dmytrotsko
Fixed expired session by using new session for each User operation
4fb920f
krivard
krivard commented May 23, 2023
View reviewed changes
@sonarqubecloud
Copy link

SonarCloud Quality Gate failed.    Quality Gate failed

Bug B 2 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot D 4 Security Hotspots
Code Smell A 25 Code Smells

No Coverage information No Coverage information
0.5% 0.5% Duplication

melange396
melange396 approved these changes May 24, 2023
View reviewed changes
Copy link
Collaborator

@melange396 melange396 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks aight to me

@melange396 melange396 marked this pull request as ready for review May 24, 2023 13:37
@melange396 melange396 merged commit 4783fcc into dev May 24, 2023
@melange396 melange396 deleted the api-keys branch May 24, 2023 13:57
@melange396 melange396 restored the api-keys branch May 24, 2023 14:03
@melange396
Copy link
Collaborator

restored branch so we can continue to use the auto-deployment to the staging server, so we can experiment with any changes we might need to do in the near future

@melange396 melange396 mentioned this pull request May 24, 2023
Merged
melange396 added a commit that referenced this pull request May 24, 2023
@melange396 @krivard
@dmytrotsko @korlaxxalrok
Merge pull request #1178 from cmu-delphi/release/delphi-epidata-4.1.0
5ca1bef 
* API keys (#1115)

* chore: release delphi-epidata 4.1.0

---------

Co-authored-by: Katie Mazaitis <[email protected]>
Co-authored-by: Dmytro Trotsko <[email protected]>
Co-authored-by: Brian Clark <[email protected]>
Co-authored-by: george haff <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dmytrotsko dmytrotsko dmytrotsko left review comments

@melange396 melange396 melange396 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@krivard @melange396 @dmytrotsko @korlaxxalrok